Cards are a common organizing unit for modern user interfaces (UI). At their core, they’re just rectangular containers with borders and padding. However, when utilized properly to group related information, they help users better digest, engage, and navigate through content. This is why most successful dashboard/UI frameworks make cards a core feature of their component library. This article provides an overview of the API that bslib provides to create Bootstrap cards.
Setup code
To demonstrate that bslib cards work outside of Shiny (i.e., in R Markdown, static HTML, etc), we’ll make repeated use of statically rendered htmlwidgets like plotly and leaflet. Here’s some code to create those widgets:
library(bslib)
library(shiny)
library(htmltools)
library(plotly)
library(leaflet)
plotly_widget <- plot_ly(x = diamonds$cut) %>%
config(displayModeBar = FALSE) %>%
layout(margin = list(t = 0, b = 0, l = 0, r = 0))
leaflet_widget <- leafletOptions(attributionControl = FALSE) %>%
leaflet(options = .) %>%
addTiles()Shiny usage
Cards work equally well in Shiny. In the
examples below, replace plotly_widget with
plotlyOutput() and leaflet_widget with
leafletOutput() to adapt them for Shiny server-rendered
plots/maps.
Hello card()
A card() is designed to handle any number of “known”
card items (e.g., card_header(), card_body(),
etc) as unnamed arguments (i.e., children). As we’ll see shortly,
card() also has some useful named arguments (e.g.,
full_screen, height, etc).
At their core, card() and card items are just an HTML
div() with a special Bootstrap class, so you can use
Bootstrap’s utility classes to customize things like colors,
text, borders,
etc.
card(
card_header(
class = "bg-dark",
"A header"
),
card_body(
markdown("Some text with a [link](https://github.com)")
)
)Some text with a link
Implicit card_body()
If you find yourself using card_body() without changing
any of its defaults, consider dropping it altogether since any direct
children of card() that aren’t “known” card()
items, are wrapped together into an implicit card_body()
call.1
For example, the code to the right generates HTML that is identical to
the previous example:
card(
card_header(
class = "bg-dark",
"A header"
),
markdown("Some text with a [link](https://github.com).")
)Some text with a link.
Restricting growth
By default, a card()’s size grows to accommodate the
size of its contents. Thus, if a card_body() contains a
large amount of text, tables, etc., you may want to specify a
height or max_height. That said, when laying
out multiple cards, it’s likely best not
to specify height on the card(), and instead, let the
layout determine the height layout_column_wrap().
Although scrolling is convenient for reducing the amount of space
required to park lots of content, it can also be a nuisance to the user.
To help reduce the need for scrolling, consider pairing scrolling with
full_screen = TRUE (which adds an icon to expand the card’s
size to the browser window). Notice how, when the card is expanded to
full-screen, max_height/height won’t effect
the full-screen size of the card.
card(
max_height = 250,
full_screen = TRUE,
card_header(
"A long, scrolling, description"
),
lorem::ipsum(paragraphs = 3, sentences = 5)
)Consectetur tempus cras diam ante, lobortis taciti vehicula; inceptos imperdiet, habitant suspendisse integer! Rhoncus pharetra diam a sagittis justo nunc netus a. Primis eleifend lectus arcu volutpat, nascetur congue pharetra enim cum. Enim neque nibh est nisi congue gravida integer eleifend platea! Senectus velit mus sodales erat in tellus?
Amet porttitor id facilisis hendrerit ultricies turpis enim viverra, ut vestibulum class. In habitasse vulputate dignissim tincidunt semper litora etiam porttitor. Leo cubilia leo lectus turpis gravida justo, curae a; nam facilisis tempor? Enim sem curabitur conubia condimentum tempor. Praesent scelerisque purus inceptos curabitur, etiam parturient nostra a mollis laoreet maecenas.
Lorem at duis congue etiam nullam tortor, in velit, curabitur commodo eget tristique sem. Mauris velit rutrum tincidunt quis hendrerit accumsan, phasellus tempor suspendisse fermentum. Cum ad congue lectus magnis commodo dictum erat enim potenti metus? Metus tincidunt etiam aliquam at et urna aptent – facilisis gravida eu. Vehicula parturient porttitor, aliquet nam, orci – integer est!
Filling outputs
A card()’s default behavior is optimized for
facilitating filling layouts. More
specifically, if a fill item (e.g.,
plotly_widget), appears as a direct child of a
card_body(), it resizes to fit the card()s
specified height. This means, by specifying height = 250
we’ve effectively shrunk the plot’s height from its default of 400 down
to about 200 pixels. And, when expanded to full_screen, the
plot grows to match the card()’s new size.
card(
height = 250,
full_screen = TRUE,
card_header("A filling plot"),
card_body(plotly_widget)
)Most htmlwidgets (e.g., plotly, leaflet, etc) and some other Shiny
output bindings (e.g, plotOutput(),
imageOutput(), etc) are fill items by
default, so this behavior “just works” in those scenarios. And, in some
of these situations, it’s helpful to remove card_body()’s
padding, which can be done via spacing
& alignment utility classes.
card(
height = 275,
full_screen = TRUE,
card_header("A filling map"),
card_body(
class = "p-0",
leaflet_widget
),
card_footer(
class = "fs-6",
"Copyright 2023 RStudio, PBC"
)
)Fill item(s) aren’t limited in how much they grow
and shrink, which can be problematic when a card becomes very small. To
work around this, consider adding a min_height on the
card_body() container. For example, try using the handle on
the lower-right portion of this card example to make the card
taller/smaller.
This interactive example is a bit contrived in that we’re using CSS
resize to demonstrate how to make plots that don’t shrink beyond a
certain point, but this concept becomes quite useful when implementing
page-level filling layouts (i.e.,
page_fillable()) with multiple
cards.
card(
height = 300,
style = "resize:vertical;",
card_header("Plots that grow but don't shrink"),
card_body(
min_height = 250,
plotly_widget,
plotly_widget
)
)Troubleshooting fill
As you’ll learn more about in filling
layouts, a fill item loses its ability to fill when
wrapped in additional UI element that isn’t a fillable
container. To fix the situation, use as_fill_carrier() to
allow the additional element to carry the potential to fill from the
card_body() down to the fill item.
Multiple card_body()
A card() can have multiple card_body()s,
which is especially useful for:
- Combining both resizable and non-resizable contents (i.e., fill items and non-fill).
- Allowing each
card_body()to have their own styling (via inline styles and/or utility classes) and resizing limits (e.g.,min_height).
For example, when pairing filling output with scrolling content, you
may want min_height on the filling output since the
scrolling content will force it to shrink:
card(
height = 375,
full_screen = TRUE,
card_header(
"Filling plot, scrolling description"
),
card_body(
min_height = 200,
plotly_widget
),
card_body(
class = "lead container",
lorem::ipsum(paragraphs = 10, sentences = 5)
)
)Sit tincidunt porta penatibus diam duis nam laoreet consequat. Cum mattis ullamcorper non aliquet, varius consequat a taciti risus euismod sociosqu? Tempus ut mattis praesent id varius, quis non dignissim malesuada facilisi! Venenatis tellus potenti lacus duis egestas posuere, ultrices sociis tristique bibendum. Consequat senectus aliquet arcu aliquam?
Amet curabitur nostra curabitur etiam rutrum id lacus nibh mi nisl, arcu rutrum eu metus habitasse. Dictumst egestas sociosqu hac pellentesque. Non odio etiam curae augue dui vel ridiculus diam tortor lobortis quam varius turpis neque. Conubia cum duis conubia ornare? Montes massa porttitor varius, curabitur velit ad luctus diam volutpat turpis mi, a egestas posuere inceptos maecenas senectus nunc per proin?
Consectetur quisque nisl lacus aenean ornare, leo, a sociosqu proin at; eros faucibus metus! Dis curae, quam; nascetur nunc morbi phasellus nam. Sagittis est porttitor nibh nam massa laoreet morbi varius, a primis rutrum. Sapien pretium euismod – mauris a semper nisl posuere magna. Rutrum erat dictumst scelerisque, dictum egestas purus fusce arcu integer ante in!
Ipsum nunc hac dis, ad tempus cras vitae, diam parturient ornare. Suscipit tempus ridiculus hac justo lectus lobortis vitae nisi? Etiam mi porttitor dui egestas consequat lacinia quis pretium. Praesent in inceptos proin: fringilla lectus dis dignissim nibh habitant. Himenaeos sodales natoque a; sociis odio ante sapien vestibulum morbi fringilla vitae faucibus massa!
Dolor litora nam pulvinar sem; quam, interdum metus egestas blandit. Urna phasellus curabitur sollicitudin, faucibus enim sociis himenaeos – eleifend lacinia. Ad luctus bibendum at – class mi. Nascetur sagittis ridiculus vulputate ridiculus metus litora, cubilia massa duis. Etiam id sagittis aliquet tellus enim.
Adipiscing sociis; euismod dictum laoreet netus elementum netus neque vehicula dictumst? Sociosqu turpis ornare potenti dui lobortis tellus imperdiet vel, cum mus, nec donec. Curae tortor quis mauris gravida senectus suscipit. Velit commodo nascetur arcu ante tellus arcu mi nullam velit neque. Ante maecenas faucibus, lacus vivamus felis aliquam hendrerit dis.
Ipsum nam nulla proin senectus, himenaeos bibendum enim ad ac urna. Nostra rhoncus nunc eu cras parturient morbi dis leo donec condimentum? Montes ornare magna euismod id: morbi nulla dui tincidunt porttitor primis. Suspendisse quis platea habitant penatibus, phasellus litora eros hendrerit integer elementum aenean. Na aenean?
Lorem primis sagittis porta non vehicula, egestas gravida dui cras fringilla. Integer nibh magna, lacinia odio odio curabitur fusce sodales euismod fermentum – potenti ridiculus. Arcu natoque sed dignissim natoque senectus, dignissim convallis rhoncus lectus porttitor! Aptent congue curabitur auctor nulla, laoreet, facilisi curabitur; venenatis praesent. Eu gravida cursus molestie sociosqu!
Elit non aenean, mattis aliquet vehicula habitant mollis! Nunc aliquam mattis porttitor dapibus, fusce hendrerit suspendisse vivamus eleifend platea! Est turpis scelerisque risus vestibulum cubilia dignissim volutpat mollis fames? Vulputate neque quam arcu et vel non laoreet magnis suscipit. Scelerisque cum facilisi enim varius lectus vulputate dignissim fermentum tempor, tellus lacus tempor morbi dictum.
Ipsum penatibus eleifend elementum habitant congue, phasellus pellentesque pulvinar maecenas? Aliquam aliquam dapibus, nibh id et sollicitudin curae cubilia vehicula. Feugiat nostra venenatis nibh suspendisse neque, suspendisse molestie ut quis porttitor sem sollicitudin. Senectus turpis neque dictumst; penatibus eget et! Augue nisl semper sollicitudin.
Also, when the content has a fixed size, and should not be allowed to
scroll, set fill = FALSE:
card(
height = 350,
full_screen = TRUE,
card_header(
"Filling plot, short description"
),
plotly_widget,
card_body(
fill = FALSE, gap = 0,
card_title("A subtitle"),
p(class = "text-muted", "And a caption")
)
)A subtitle
And a caption
Multiple columns
As you’ll learn in column-based
layouts, layout_column_wrap() is great for multi-column
layouts that are responsive and accommodate for filling output. Here we have an equal-width
2-column layout using width = 1/2, but it’s also possible
to have varying column
widths.
card(
height = 350,
full_screen = TRUE,
card_header("A multi-column filling layout"),
card_body(
min_height = 200,
layout_column_wrap(
width = 1/2,
plotOutput("p1"),
plotOutput("p2")
)
),
lorem::ipsum(paragraphs = 3, sentences = 5)
)Ipsum cras porta: mus lobortis purus quis, hendrerit purus a? Dapibus facilisis tortor metus ligula habitasse class a, aliquam, quis purus facilisi ante. Malesuada ut eleifend habitant euismod tellus nascetur quis habitant. Tempus ullamcorper leo lobortis convallis facilisis ac? Hendrerit feugiat tristique – non, posuere, penatibus natoque sodales curae porta posuere!
Sit est feugiat parturient neque, cursus risus magna dui! Leo rhoncus turpis tempor sapien: est interdum fusce! Commodo integer proin luctus accumsan risus mollis sociosqu? Primis morbi nunc odio natoque, diam parturient posuere tincidunt molestie? Vitae neque class volutpat dictumst montes habitasse condimentum molestie etiam habitant mus netus scelerisque, felis; accumsan taciti, torquent urna habitant tristique magnis porttitor lacinia.
Dolor sed lacus, ornare eros proin tempor. Leo per varius, rhoncus proin vivamus platea euismod. Eros morbi risus, nunc felis sociis est arcu lectus tortor mollis nostra. Dis habitasse lectus praesent, blandit ante eu arcu himenaeos. Massa cursus est fames sed mattis habitasse ullamcorper lacinia rhoncus condimentum erat senectus lobortis imperdiet gravida eu risus leo pellentesque, sociosqu nullam viverra molestie justo morbi?
Multiple cards
layout_column_wrap() is especially nice for laying out
multiple cards since each card in a particular row will have the same
height (by default). Learn more in column-based layouts.
layout_column_wrap(
width = 1/2,
height = 300,
card(full_screen = TRUE, card_header("A filling plot"), plotly_widget),
card(full_screen = TRUE, card_header("A filling map"), card_body(class = "p-0", leaflet_widget))
)Multiple tabs
navset_card_tab() and navset_card_pill()
make it possible to create cards with multiple tabs or pills. These
functions have the same full_screen capabilities as normal
card()s as well some other options like title
(since there is no natural place for a card_header() to be
used). Note that, each nav_panel() object is similar to a
card(). That is, if the direct children aren’t already card
items (e.g., card_title()), they get implicitly wrapped in a
card_body().
library(leaflet)
navset_card_tab(
height = 450,
full_screen = TRUE,
title = "HTML Widgets",
nav_panel(
"Plotly",
card_title("A plotly plot"),
plotly_widget
),
nav_panel(
"Leaflet",
card_title("A leaflet plot"),
leaflet_widget
),
nav_panel(
shiny::icon("circle-info"),
markdown("Learn more about [htmlwidgets](http://www.htmlwidgets.org/)")
)
)Sidebars
As you’ll learn more about in sidebar
layouts, layout_sidebar() just works when placed inside
in a card(). In this case, if you want fill
items (e.g., plotly_widget) to still fill the card
like we’ve seen before, you’ll need to
set fillable = TRUE in layout_sidebar().
card(
height = 300,
full_screen = TRUE,
card_header("A sidebar layout inside a card"),
layout_sidebar(
fillable = TRUE,
sidebar = sidebar(
actionButton("btn", "A button")
),
plotly_widget
)
)Static images
card_image() makes it easy to embed static (i.e.,
pre-generated) images into a card. Provide a URL to href to
make it clickable. In the case of multiple card_image()s,
consider laying them out in multiple cards
with layout_column_wrap() to produce a grid of clickable
thumbnails.
card(
height = 300,
full_screen = TRUE,
card_image(
file = "shiny-hex.svg",
href = "https://github.com/rstudio/shiny"
),
card_body(
fill = FALSE,
card_title("Shiny for R"),
p(
class = "fw-light text-muted",
"Brought to you by RStudio."
)
)
)
Shiny for R
Brought to you by RStudio.
Flexbox
Both card() and card_body() default to
fillable = TRUE (that is, they are CSS flexbox
containers), which works wonders for facilitating filling outputs, but it also leads to
surprising behavior with inline tags (e.g., actionButton(),
span(), strings, etc). Specifically, each inline tag is
placed on a new line, but in a “normal” layout flow
(fillable = FALSE), inline tags render inline.
card(
card_body(
fillable = TRUE,
"Here's some", tags$i("inline"), "text",
actionButton("btn1", "A button")
),
card_body(
fillable = FALSE,
"Here's some", tags$i("inline"), "text",
actionButton("btn2", "A button")
)
)That said, sometimes working in a flexbox layout is quite useful,
even when working with inline tags. Here we leverage flexbox’s gap
property to control the spacing between a plot, a (full-width) button,
and paragraph. Note that, by using markdown() for the
paragraph, it wraps the results in a <p> tag, which
means the contents of the paragraph are not longer subject to
flexbox layout. If we wanted, we could do something similar to render
the actionButton() inline by wrapping it in a
div().
card(
height = 325, full_screen = TRUE,
card_header("A plot with an action links"),
card_body(
class = "gap-2 container",
plotly_widget,
actionButton(
"go_btn", "Action button",
class = "btn-primary rounded-0"
),
markdown("Here's a _simple_ [hyperlink](https://www.google.com/).")
)
)In addition to gap, flexbox has really nice ways of handling otherwise difficult spacing and alignment issues. And, thanks to Bootstrap’s flex utility classes, we can easily opt-in and customize defaults.
card(
height = 300, full_screen = TRUE,
card_header(
class = "d-flex justify-content-between",
"Centered plot",
checkboxInput("check", " Check me", TRUE)
),
card_body(
class = "align-items-center",
plotOutput("id", width = "75%")
)
)Shiny
Since this article is statically rendered, the examples here use
statically rendered content/widgets, but the same card()
functionality works for dynamically rendered content via Shiny (e.g.,
plotOutput(), plotlyOutput(), etc).
An additional benefit that comes with using shiny is the ability to
use getCurrentOutputInfo() to render new/different content
when the output container becomes large enough, which is particularly
useful with card(full_screen = T, ...). For example, you
may want additional captions/labels when a plot is large, additional
controls on a table, etc (see the value
boxes article for a clever use of this).
# UI logic
ui <- page_fluid(
card(
max_height = 200,
full_screen = TRUE,
card_header("A dynamically rendered plot"),
plotOutput("plot_id")
)
)
# Server logic
server <- function(input, output, session) {
output$plot_id <- renderPlot({
info <- getCurrentOutputInfo()
if (info$height() > 600) {
# code for "large" plot
} else {
# code for "small" plot
}
})
}
shinyApp(ui, server)Appendix
The following CSS is used to give plotOutput() a
background color; it’s necessary here because this documentation page is
not actually hooked up to a Shiny app, so we can’t show a real plot.